PayPal決済 随時決済 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様(.idPass)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却

EntryTranPaypal 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

JobCd 必須 半角英字8桁
処理区分

CAPTURE:即時売上
AUTH:仮売上

Amount 必須 半角数字記号10桁
利用金額

小数点(第二位まで)を含む桁数です。

Tax 半角数字記号10桁
税送料

税送料を指定した場合は、利用金額+税送料が決済金額となります。
小数点(第二位まで)を含む桁数です。

Currency 半角英字3桁
通貨コード

省略時:JPY(日本円)

URL
/payment/EntryTranPaypal.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=100
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranPaypal 決済実行

PayPalと通信を行い決済要求結果を返します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

Locale 半角英字2桁
言語

PayPal決済画面上に表示する言語を選択します。無指定の場合、日本語が表示されます。

PaymentType 必須 半角英字10桁
決済タイプ

下記を設定します。
SETTLEMENT:随時決済

PaypalBillingAgreementID 必須 半角英数19桁
支払同意ID

「利用承諾」「都度決済+利用承諾」で発行された支払同意IDを設定してください。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

ClientFieldFlag 半角数字1桁 固定
加盟店自由項目返却フラグ

以下のいずれかを設定します。
0:返却しない(デフォルト)
1:返却する

ShipFlg 半角数字1桁 固定
配送先利用フラグ

以下のいずれかを設定します。「1」を指定した場合、配送先情報を設定してください。
0:利用しない(デフォルト)
1:利用する

ShipToName 全半角256桁
配送先氏名

・配送先利用フラグが1の場合は必須です。
・半角英数記号(除く ^`{|}~&<>')と全角文字が使用可能が使用可能です。
・名、姓の順番で、間に半角スペースを挟みます。

例)太郎 山田

ShipToZip 半角英数記号20桁
配送先郵便番号

配送先利用フラグが1の場合は必須です。
・半角英数記号(記号は-「ハイフン」のみ)が使用可能です。

例)0030001

ShipToCountryCode 半角英字2桁
配送先国コード

・ISO-3166-1に基づく、国コードを設定します。
・配送先利用フラグが1の場合は必須です。
・半角英字が使用可能です。

例)JP

ShipToState 半角英数記号40桁
配送先都道府県

・配送先利用フラグが1の場合は必須です。
・半角英数記号(記号は-「ハイフン」のみ)が使用可能です。

例)TOKYO-TO

・下記URL記載の国の場合はPayPal州コードを入力してください。

■Paypal州コード一覧
https://developer.paypal.com/docs/nvp-soap-api/state-codes/

ShipToCity 半角英数記号40桁
配送先市町村

・配送先利用フラグが1の場合は必須です。
・半角英数記号(記号は-「ハイフン」のみ)が使用可能です。

例)shibuya-ku

ShipToStreet 半角英数記号100桁
配送先番地

・配送先利用フラグが1の場合は必須です。
・半角英数記号(記号は-「ハイフン」のみ)が使用可能です。

例)dogenzaka1-99-999

ShipToStreet2 半角英数記号100桁
配送先建物名など

・配送先利用フラグが1の場合は必須です。
・半角英数記号(記号は-「ハイフン」のみ)が使用可能です。

例)humax-shibuya

URL
/payment/ExecTranPaypal.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&PaymentType=SETTLEMENT&PaypalBillingAgreementID=B-53G467521V0468537
レスポンス
正常
ShopID 半角英数13桁
ショップID

OrderID 半角英数記号27桁
オーダーID

Status
現状態

対象取引の取引状態を返却します。
・AUTH:仮売上
・CAPTURE:即時売上
・PENDING:保留中
・PAYFAIL:決済失敗

TranDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

TranID 半角英数19桁
トランザクションID

PayPalから返却された処理番号を返却します。

CheckString 半角英数記号64桁
改ざんチェック文字列

以下の情報を連結し、SHA256ハッシュした値を返却します。
・オーダーID
・取引ID
・ショップID
・ショップパスワード
・トランザクションID

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranDate=20201225091313&TranID=6KP06027ED30547N9&CheckString=3658b0e4e8b69ea2330f13cd30fbf1dc1b6411740b60f73c366a71036e8d697e
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

PaypalSales 実売上

PayPalと通信を行い取引の実売上処理を行います。 ※実売上を行うときは金額を変更することが可能です。 変更後の合計金額は、変更前の合計金額より少なくしてください。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字10桁
利用金額

税送料を指定した場合は、合計利用金額が売上確定となります。
仮売上時の合計利用金額を超える金額は指定できません。

仮売上時の合計利用金額に満たない金額を指定した場合、差額はキャンセルされます。
(一部実売上の例)
 仮売上時の利用金額 = 1000円
 指定する利用金額 = 800円
上記の条件で実売上を行った結果
 売上金額 = 800円
 キャンセル金額 = 200円

Tax 半角数字10桁
税送料

URL
/payment/PaypalSales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

TranID 半角英数19桁
トランザクションID

PayPalから返却された処理番号を返却します。

TranDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

Status
現状態

通常:SALES
仮売期限切れ:PAYFAIL

Amount 半角数字記号10桁
利用金額

小数点(第二位まで)を含む桁数です。

Tax 半角数字記号10桁
税送料

小数点(第二位まで)を含む桁数です。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&TranID=6KP06027ED30547N9&TranDate=20201225091313&Status=SALES&Amount=100&Tax=8
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

CancelAuthPaypal 仮売上取消

PayPalと通信を行い、取引の仮売上取消処理を行います。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

URL
/payment/CancelAuthPaypal.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

TranID 半角英数19桁
トランザクションID

PayPalから返却された処理番号を返却します。

TranDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

Status
現状態

成功時:AUTH_CANCEL

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&TranID=6KP06027ED30547N9&TranDate=20201225091313&Status=AUTH_CANCEL
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

CancelTranPaypal キャンセル

PayPalと通信を行い、取引のキャンセル処理を行います。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字記号10桁
利用金額

小数点(第二位まで)を含む桁数です。

Tax 半角数字記号10桁
税送料

小数点(第二位まで)を含む桁数です。

URL
/payment/CancelTranPaypal.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

TranID 半角英数19桁
トランザクションID

PayPalから返却された処理番号を返却します。

TranDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&TranID=6KP06027ED30547N9&TranDate=20201225091313
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

5:PayPal決済

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=5
レスポンス
正常
Status
現状態

UNPROCESSED:未決済
AUTH:仮売上
SALES:実売上
CAPTURE:即時売上
PENDING:保留中
AUTH_CANCEL:仮売上取消
CANCEL:キャンセル
PAYFAIL:決済失敗
EXPIRED:期限切れ

ProcessDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

JobCd
処理区分

AUTH:仮売上
SALES:実売上
CAPTURE:即時売上
AUTH_CANCEL:仮売上取消
CANCEL:キャンセル

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Amount 半角数字7桁
利用金額

Tax 半角数字7桁
税送料

Currency 半角英字3桁
通貨コード

TranID 半角英数28桁
トランザクションID

PayPalから返却された処理番号を返却します。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

5:PayPal

PaypalPaymentType 半角英字10桁
決済タイプ

SETTLEMENT:随時決済

PaypalAgreementCurrentstatus
利用承諾現状態

nullで返却します。

PaypalAgreementID
支払同意ID

nullで返却します。

PaypalBillingAgreementID 半角英数記号19桁
随時決済用支払同意ID

決済実行時に指定された決済用支払同意IDを返却します。

PaypalAgreementStartDate
利用承諾日付

nullで返却します。

PaypalAgreementEndDate
利用終了日付

nullで返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
Status=AUTH&ProcessDate=20201225091313&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=8&Currency=JPY&TranID=6KP06027ED30547N9&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=5&PaypalPaymentType=SETTLEMENT&PaypalAgreementCurrentstatus=&PaypalAgreementID=&PaypalBillingAgreementID=B-53G467521V0468537&PaypalAgreementStartDate=&PaypalAgreementEndDate=
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001